Skip to main content

New-IMMemory

SYNOPSIS​

Creates a new memory collection in Immich.

SYNTAX​

New-IMMemory [[-Session] <ImmichSession>] [[-Year] <Int32>] [[-AssetIds] <String[]>] [-MemoryAt] <DateTime>
 [[-SeenAt] <DateTime>] [[-Type] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

The New-IMMemory function creates a new memory in Immich, which is a curated collection of assets organized around a specific date, event, or theme. Memories help users rediscover their photos through temporal organization and can be configured for different types of reminiscence experiences.

The function supports creating 'on_this_day' type memories that highlight assets from previous years on the same date, helping users revisit past moments and experiences.

EXAMPLES​

EXAMPLE 1​

New-IMMemory -MemoryAt "2024-01-01 00:00:00" -AssetIds 'bf973405-3f2a-48d2-a687-2ed4167164be', '9c4e0006-3a2b-4967-94b6-7e8bb8490a12'

Creates a New Year's Day memory for 2024 with two specific assets.

EXAMPLE 2​

New-IMMemory -MemoryAt (Get-Date "2023-12-25") -Type 'on_this_day' -Year 2023

Creates a Christmas Day memory for 2023 using DateTime object for the date.

EXAMPLE 3​

$assets = Get-IMAsset | Where-Object { $_.fileCreatedAt -like '*-07-04*' }
New-IMMemory -MemoryAt "2024-07-04" -AssetIds $assets.id

Creates a memory for July 4th using assets filtered by creation date.

PARAMETERS​

-Session​

Optionally define a immich session object to use. This is useful when you are connected to more than one immich instance.

-Session $Session

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Year​

Specifies the year component for the memory. This helps organize memories by temporal periods and can be used to create year-specific memory collections.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-AssetIds​

Specifies an array of asset IDs to include in the memory. These assets will be associated with the memory and displayed when the memory is viewed. Assets should be relevant to the memory's date or theme.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MemoryAt​

Specifies the date and time when the memory is anchored. This represents the focal point of the memory and is used to organize and present the associated assets. Must be provided in a valid DateTime format.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SeenAt​

Specifies when the memory was last viewed or acknowledged by the user. This helps track user engagement with memories and can influence how memories are presented.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Type​

Specifies the type of memory to create. Currently supports 'on_this_day' which creates memories that highlight assets from the same date in previous years. Defaults to 'on_this_day' if not specified.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: On_this_day
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

Memories provide a way to automatically surface relevant photos from the past, enhancing the user experience by helping rediscover forgotten moments.

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github